Add easy initialization macros #1270

pitdicker · 2023-09-08T08:57:43Z

I am very happy to have something like this!

// NaiveDate
date!(2023-09-08); // calendar date
date!(2023-251); // ordinal date

// NaiveTime
time!(7:03); // seconds are optional
time!(7:03:00);
time!(23:59:60); // leap second

// NaiveDateTime
datetime!(2023-09-08 7:03);
datetime!(2023-09-08 7:03:25);

// DateTime<FixedOffset>
datetime!(2023-09-08 7:03:25+02:00);
datetime!(2023-09-08 7:03:25-02:00);

My macro skills are not great though. I do not know how to avoid the code duplication. And I can't make the time! macro support fractional seconds yet. Something TT muncher something.

~~Depends on #1069 for creating a const DateTime<FixedOffset>.~~

Fixes #13.

codecov · 2023-09-08T09:04:09Z

Codecov Report

Attention: Patch coverage is 71.92982% with 32 lines in your changes are missing coverage. Please review.

Project coverage is 91.67%. Comparing base (6c4e735) to head (2d52c4b).

Files	Patch %	Lines
src/macros.rs	71.92%	32 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1270      +/-   ##
==========================================
- Coverage   91.79%   91.67%   -0.13%     
==========================================
  Files          37       38       +1     
  Lines       18185    18299     +114     
==========================================
+ Hits        16693    16775      +82     
- Misses       1492     1524      +32

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pitdicker · 2023-09-08T09:17:29Z

Another open problem: clippy warns about integers starting with 0, which is common in date and time values.

djc · 2023-09-08T09:36:58Z

Another open problem: clippy warns about integers starting with 0, which is common in date and time values.

Can probably add clippy #[allow()] attributes in the macro output?

pitdicker · 2023-09-08T13:56:27Z

Fixed the clippy warning with help from @Alexendoo in rust-lang/rust-clippy#11472.

pitdicker · 2023-09-13T06:29:37Z

The macro to create a DateTime<FixedOffset> hits the same problem as in Make methods on NaiveDateTime const where possible #1286 (comment): Rust 1.57 doesn't support making DateTime<Tz>::from_naive_utc_and_offset const.
Added a workaround.
We can't easily see whether a macro is const, so I added a test for it.
Added an offset! macro. offset!(+05:43) is a lot easier to read then FixedOffset::east_opt(20_580).unwrap().

pitdicker · 2023-09-24T06:47:47Z

I have separated this into smaller commits.

And by creating a temporary const inside the macros we can guarantee the values are always checked at compile time.

pitdicker · 2024-01-30T16:53:59Z

Updated to remove the rust 1.57 workaround.

These macro's can make tests nicer to read. Example commit: 8e4092f.
They give us parity with one of the selling points of the time crate.

jtmoon79

These are very handy!

I have some suggestions to improve user-friendliness.

jtmoon79 · 2024-01-30T18:16:12Z

src/macros.rs

@@ -0,0 +1,316 @@
+//! Macro's for easy initialization of date and time values.
+
+/// Create a `NaiveDate` with a statically known value.


Link the NaiveDate.

Since the macro does not have a return type the docs will not automatically link to NaiveDate.

So change to a link

/// Create a [`NaiveDate`] with ...

at the bottom, add the link target

/// [`NaiveDate`]: crate::naive::NaiveDate

btw, if you use VS Code, it will highlight the link to turquoise blue when it is correctly set.

This nitpick goes for the rest of the PR.

jtmoon79 · 2024-01-30T18:20:09Z

src/macros.rs

+    (-$h:literal:$m:literal) => {{
+        #[allow(clippy::zero_prefixed_literal)]
+        {
+            assert!($h < 24 || $m < 60, "invalid offset");


I recommend splitting these out to be more specific what value is wrong. Also, reprint the wrong value. This helps the user quickly and easily identify the culprit.

assert!($h < 24, "invalid hour offset {}", $h); assert!($m < 60, "invalid minute offset {}", $m);

Apply this comment to rest of the PR.

jtmoon79 · 2024-01-30T18:27:31Z

src/macros.rs

+        {
+            const DATE: $crate::NaiveDate = match $crate::NaiveDate::from_ymd_opt($y, $m, $d) {
+                Some(d) => d,
+                None => panic!("invalid calendar date"),


I prefer to repeat back to the user the invalid values. More specific clues in error messages are always nice.

panic!("invalid calendar date from values {:?}, {:?}, {:?}", $y, $m, $d)

Apply this comment to rest of the PR.

Good comments, thanks @jtmoon79!
I'm not sure if we can use a format string for panics in const context, let me try.

Because these macro's are evaluated at compile time the message is already quite nice in my opinion:

error[E0080]: evaluation of constant value failed --> src\macros.rs:52:20 | 52 | assert_eq!(date!(2023-04-31), NaiveDate::from_ymd_opt(2023, 4, 30).unwrap()); | ^^^^^^^^^^^^^^^^^ the evaluated program panicked at 'invalid calendar date', src\macros.rs:52:20 |

Because these macro's are evaluated at compile time the message is already quite nice in my opinion:

error[E0080]: evaluation of constant value failed --> src\macros.rs:52:20 | 52 | assert_eq!(date!(2023-04-31), NaiveDate::from_ymd_opt(2023, 4, 30).unwrap()); | ^^^^^^^^^^^^^^^^^ the evaluated program panicked at 'invalid calendar date', src\macros.rs:52:20 |

I still think a nice touch here is to be specific about precisely which argument caused the panic. Up to you.

jtmoon79

Approved. However I like my idea of getting specific about precisely which argument made the date invalid. Up to you.

sorairolake · 2024-03-08T03:13:55Z

I think it would be useful to have an initialization macro for DateTime<Utc>.

// DateTime<Utc>
datetime!(2023-09-08 7:03:25Z);

// DateTime<FixedOffset>
datetime!(2023-09-08 7:03:25+00:00);

pitdicker · 2024-03-08T05:45:47Z

I think it would be useful to have an initialization macro for DateTime<Utc>.

Agreed. But as I understand such a syntax, using a letter after a number, is not supported by simple macro's. And my goal was to keep it simple, without resorting to proc macro's.

Note that you can do

// DateTime<Utc>
datetime!(2023-09-08 7:03:25).and_utc();

pitdicker · 2024-03-28T07:07:39Z

Found a way to accept a time with fractions of a second using the stringify macro!

So we can now also do time!(7:03:15.01), and the same for datetime!().

@djc What would be needed to push this PR forwards? I think it will be a really good addition to improve the ergonomics of chrono.

b.t.w. I opened rust-lang/rust#123156 for the CI errors.

Elrendio · 2024-09-30T13:36:26Z

Hey 👋

Just dropping this in case you want to use it. When the panicking APIs were deprecated we implemented an extension trait to have easy initialization. It won't solve your issue with const context but it works very well in other context 😊

use chrono::TimeDelta;

pub trait TimeDeltaExt {
	fn weeks<Int: WaySmallerThanI64>(weeks: Int) -> Self;
	fn days<Int: WaySmallerThanI64>(days: Int) -> Self;
	fn hours<Int: WaySmallerThanI64>(hours: Int) -> Self;
	fn minutes<Int: WaySmallerThanI64>(minutes: Int) -> Self;
	fn seconds<Int: WaySmallerThanI64>(seconds: Int) -> Self;
	fn milliseconds<Int: WaySmallerThanI64>(milliseconds: Int) -> Self;
}

impl TimeDeltaExt for TimeDelta {
	fn weeks<Int: WaySmallerThanI64>(weeks: Int) -> Self {
		Self::try_weeks(weeks.into())
			.expect("-(i64::MAX / 1_000) < (WaySmallerThanI64 * 7 * 24 * 60 * 60) < (i64::MAX / 1_000)")
	}
	fn days<Int: WaySmallerThanI64>(days: Int) -> Self {
		Self::try_days(days.into())
			.expect("-(i64::MAX / 1_000) < (WaySmallerThanI64 * 24 * 60 * 60) < (i64::MAX / 1_000)")
	}
	fn hours<Int: WaySmallerThanI64>(hours: Int) -> Self {
		Self::try_hours(hours.into()).expect("-(i64::MAX / 1_000) < (WaySmallerThanI64 * 60 * 60) < (i64::MAX / 1_000)")
	}
	fn minutes<Int: WaySmallerThanI64>(minutes: Int) -> Self {
		Self::try_minutes(minutes.into()).expect("-(i64::MAX / 1_000) < (WaySmallerThanI64 * 60) < (i64::MAX / 1_000)")
	}
	fn seconds<Int: WaySmallerThanI64>(seconds: Int) -> Self {
		Self::try_seconds(seconds.into()).expect("-(i64::MAX / 1_000) < WaySmallerThanI64 < (i64::MAX / 1_000)")
	}
	fn milliseconds<Int: WaySmallerThanI64>(milliseconds: Int) -> Self {
		Self::try_milliseconds(milliseconds.into()).expect("-i64::MAX < i32 < i64WaySmallerThanI64MAX")
	}
}

pub(crate) trait WaySmallerThanI64: Into<i64> {}

impl WaySmallerThanI64 for u8 {}
impl WaySmallerThanI64 for u16 {}
impl WaySmallerThanI64 for u32 {}
impl WaySmallerThanI64 for i8 {}
impl WaySmallerThanI64 for i16 {}
impl WaySmallerThanI64 for i32 {}

pitdicker mentioned this pull request Sep 8, 2023

Is it possible to disable a lint for all macro invocations? rust-lang/rust-clippy#11472

Closed

pitdicker force-pushed the init_macros branch from 402fe1c to 0cb1204 Compare September 8, 2023 13:50

pitdicker mentioned this pull request Sep 12, 2023

(overflowing|checked)_(add|sub)_offset implementations #1069

Merged

pitdicker force-pushed the init_macros branch from 0cb1204 to b1769a6 Compare September 13, 2023 06:24

djc added the waiting-on-review label Sep 13, 2023

pitdicker mentioned this pull request Sep 23, 2023

Add NaiveDateTime::checked_(add|sub)_offset #1313

Merged

pitdicker force-pushed the init_macros branch from b1769a6 to c693f86 Compare September 24, 2023 06:46

pitdicker force-pushed the init_macros branch from c693f86 to 972a08f Compare September 25, 2023 11:27

pitdicker mentioned this pull request Sep 27, 2023

0.5 release planning #970

Open

pitdicker force-pushed the init_macros branch from 972a08f to 6e3f9fc Compare January 30, 2024 16:50

jtmoon79 reviewed Jan 30, 2024

View reviewed changes

pitdicker force-pushed the init_macros branch from 6e3f9fc to 3126c6b Compare January 30, 2024 21:40

jtmoon79 approved these changes Jan 31, 2024

View reviewed changes

pitdicker mentioned this pull request Feb 2, 2024

Consider refactoring chrono to avoid systematic misuse of panics #815

Closed

pitdicker mentioned this pull request Mar 6, 2024

Ergonomic replacements for panicking APIs. #1491

Closed

pitdicker force-pushed the init_macros branch from 852d32d to c7e650a Compare March 28, 2024 06:31

pitdicker added 4 commits March 30, 2024 15:47

Add date! macro

5db2531

Add time! macro

31ce223

Add datetime! macro

248baf6

Add offset! macro

327b520

pitdicker added 2 commits March 30, 2024 15:47

Extend datetime! macro to also create DateTime<FixedOffset>

99a70d6

Support parsing fractional seconds

2d52c4b

pitdicker force-pushed the init_macros branch from c7e650a to 2d52c4b Compare March 30, 2024 14:47

		@@ -0,0 +1,316 @@
		//! Macro's for easy initialization of date and time values.

		/// Create a `NaiveDate` with a statically known value.

Add easy initialization macros #1270

Are you sure you want to change the base?

Add easy initialization macros #1270

Uh oh!

Conversation

pitdicker commented Sep 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pitdicker commented Sep 8, 2023

Uh oh!

djc commented Sep 8, 2023

Uh oh!

pitdicker commented Sep 8, 2023

Uh oh!

pitdicker commented Sep 13, 2023

Uh oh!

pitdicker commented Sep 24, 2023

Uh oh!

pitdicker commented Jan 30, 2024

Uh oh!

jtmoon79 left a comment

Choose a reason for hiding this comment

Uh oh!

jtmoon79 Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jtmoon79 Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

jtmoon79 Jan 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pitdicker Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

pitdicker Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

jtmoon79 Jan 31, 2024

Choose a reason for hiding this comment

Uh oh!

jtmoon79 left a comment

Choose a reason for hiding this comment

Uh oh!

sorairolake commented Mar 8, 2024

Uh oh!

pitdicker commented Mar 8, 2024

Uh oh!

pitdicker commented Mar 28, 2024

Uh oh!

Elrendio commented Sep 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pitdicker commented Sep 8, 2023 •

edited

Loading

codecov bot commented Sep 8, 2023 •

edited

Loading

jtmoon79 Jan 30, 2024 •

edited

Loading

jtmoon79 Jan 30, 2024 •

edited

Loading